Exponent::GUI::Controls::CSlider

Exponent::GUI::Controls::CSlider Class Reference

Inheritance diagram for Exponent::GUI::Controls::CSlider:

List of all members.

Detailed Description

Represents a slider.

Date:: 19/03/2005

Author:: Paul Chana

Version:: 1.0.0 Initial version

Note:: All contents of this source code are copyright 2005 Exp Digital Uk.
This source file is covered by the licence conditions of the Infinity API. You should have recieved a copy
with the source code. If you didnt, please refer to http://www.expdigital.co.uk All content is the Intellectual property of Exp Digital Uk.
Certain sections of this code may come from other sources. They are credited where applicable.
If you have comments, suggestions or bug reports please visit http://support.expdigital.co.uk

Id: CSlider.hpp,v 1.6 2007/02/08 21:07:54 paul Exp

Definition at line 39 of file CSlider.hpp.

Public Member Functions

CSlider (IControlRoot *root, const long uniqueId, const CRect &area, IActionListener *listener=NULL)
virtual void drawControl (CGraphics &graphics)
virtual void handleLeftButtonDown (CMouseEvent &event)
virtual void handleLeftButtonUp (CMouseEvent &event)
virtual void handleMouseLeavingArea (CMouseEvent &event)
virtual void handleMouseMovement (CMouseEvent &event)
virtual void handleMouseScroll (CMouseEvent &event)
virtual void setColours (CAlphaColour frameColour, CAlphaColour backgroundColour, CAlphaColour handleColour, CAlphaColour handleOverColour, CAlphaColour handleDownColour)
virtual void setSliderImages (IImage *sliderHandle, IImage *sliderOver, IImage *sliderDown, IImage *sliderDisabled)
virtual void setValue (const double value)
virtual ~CSlider ()

Protected Member Functions

virtual void checkAndLock (const CPoint &point)
virtual bool drawEnabledControl (CGraphics &graphics)

Protected Attributes

Constructor & Destructor Documentation

Exponent::GUI::Controls::CSlider::CSlider	(	IControlRoot *	root,
		const long	uniqueId,
		const CRect &	area,
		IActionListener *	listener = `NULL`
	)

Construction

Parameters:

	root	The root control that this control is being added to
	uniqueId	The unique Identifier of this control or CCONTROL_NO_ID_REQUIRED if no id is required
	area	The area of this control relative to the root controls top left
	listener	The action listener

virtual Exponent::GUI::Controls::CSlider::~CSlider ( ) [virtual]

Destruction

Member Function Documentation

virtual void Exponent::GUI::Controls::CSlider::checkAndLock ( const CPoint & point ) [protected, virtual]

Check if the area is rolled over and lock if it is

Parameters:

point

The point to check

virtual void Exponent::GUI::Controls::CSlider::drawControl ( CGraphics & graphics ) [virtual]

Draw the controls

Parameters:

graphics

The graphics context

Reimplemented from Exponent::GUI::Controls::CControl.

Reimplemented in Exponent::GUI::Controls::CScrollBar.

virtual bool Exponent::GUI::Controls::CSlider::drawEnabledControl ( CGraphics & graphics ) [protected, virtual]

Check if the control is enabled. If it isnt, draw the disabled background and return

Parameters:

graphics

The graphics context

Return values:

bool

TRue if should draw, false if disabled / shouldnt draw

Reimplemented from Exponent::GUI::Controls::CControl.

virtual void Exponent::GUI::Controls::CSlider::handleLeftButtonDown ( CMouseEvent & event ) [virtual]

Handle left button being clicked

Parameters:

event

The event to handle

Reimplemented from Exponent::GUI::Controls::CControl.

virtual void Exponent::GUI::Controls::CSlider::handleLeftButtonUp ( CMouseEvent & event ) [virtual]

Handle left button being released

Parameters:

event

The event to handle

Reimplemented from Exponent::GUI::Controls::CControl.

virtual void Exponent::GUI::Controls::CSlider::handleMouseLeavingArea ( CMouseEvent & event ) [virtual]

Handle the mouse leaving the window area

Parameters:

event

The event to handle

Reimplemented from Exponent::GUI::Controls::CControl.

virtual void Exponent::GUI::Controls::CSlider::handleMouseMovement ( CMouseEvent & event ) [virtual]

Handle the mouse movement

Parameters:

event

The event to handle

Reimplemented from Exponent::GUI::Controls::CControl.

virtual void Exponent::GUI::Controls::CSlider::handleMouseScroll ( CMouseEvent & event ) [virtual]

Handle the scroll wheel

Parameters:

event

The event to handle

Reimplemented from Exponent::GUI::Controls::CControl.

virtual void Exponent::GUI::Controls::CSlider::setColours	(	CAlphaColour	frameColour,
		CAlphaColour	backgroundColour,
		CAlphaColour	handleColour,
		CAlphaColour	handleOverColour,
		CAlphaColour	handleDownColour
	)			`[virtual]`

Set the colours

Parameters:

	frameColour	The colour of the frame
	backgroundColour	The background colour of the control
	handleColour	The colour of the area that can be grabbed by the user
	handleOverColour	The colour of the area that can be grabbed by the user when mouse is over
	handleDownColour	The colour of the area that can be grabbed by the user when mouse is grabbing it

virtual void Exponent::GUI::Controls::CSlider::setSliderImages	(	IImage *	sliderHandle,
		IImage *	sliderOver,
		IImage *	sliderDown,
		IImage *	sliderDisabled
	)			`[virtual]`

Set the slider images

Parameters:

	sliderHandle	The image of the area that can be grabbed by the user
	sliderOver	The image of the area that can be grabbed by the user when mouse is over
	sliderDown	The image of the area that can be grabbed by the user when mouse is grabbing it
	sliderDisabled	The image of the area that can be grabbed by the user when the control is disabled